Skip to main content

Submit First Land Based Receiver Events

Method: POST
/events/first-land-based-receiver

As a Customer of iFoodDS, you use the iFoodDS First Land Based Receiver (FLBR) Event API to send FSMA 204 FLBR event data to the iFoodDS Trace Exchange platform. Event records will be stored for a minimum of two years.

info

This endpoint is being refined and thus subject to change. These docs will update when changes are made.

Request​

Type: application/json

The body of the request comprises three main sections: the productMasterDataList, the locationMasterList, and the eventList. The first two sections are there to reduce the duplication of data you need to provide for the eventList.

{
    "productMasterDataList": [
        {
            "itemCode": "<item code>",
            "itemDescription": "<item description>",
            "isFtlItem": true,
            "ftlCategory": "<FTL (Food Traceability List) category>",
            "brandName": "<brand name>",
            "packStyle": "<pack style>",
            "packSize": "<pack size>",
            "productCommodity": "<product commodity>",
            "productVariety": "<product variety>",
            "scientificName": "<scientific name>",
            "acceptableSpeciesName": "<acceptable species name>",
            "gtin": "<GTIN (Global Trade Item Number)>",
            "itemUpc": "<item UPC (Universal Product Code)>",
            "innerPackUpc": "<inner pack UPC>",
            "plu": "<PLU (Price Look-up)>",
            "alternateItemCode": "<alternate item code>",
            "isCoveredByGdst": true
        }
    ],
    "locationMasterList": [
        {
            "locationName": "<location name>",
            "locationCode": "<location code>",
            "locationType": "<location type>",
            "gln": "<GLN (global location number)>",
            "glnAssignedBy": "<GLN assigned by>",
            "duns": "<DUNS number>",
            "alternateLocationCode": "<alternate location id>",
            "phoneNumber": "<phone number>",
            "isPrimaryLocation": true,
            "isCoveredByGdst": false,
            "address": {
                "streetAddress1": "<street address 1>",
                "streetAddress2": "<street address 2>",
                "city": "<city>",
                "state": "<state>",
                "postalCode": "<postal code>",
                "country": "<country code>"
            },
            "geoLocation": {
                "gpsCoordinates": [
                    "<latitude>",
                    "<longitude>"
                ],
                "geoFence": [
                    [
                        "<latitude1>",
                        "<longitude1>"
                    ],
                    [
                        "<latitude2>",
                        "<longitude2>"
                    ]
                ]
            }
        }
    ],
    "eventList": [
        {
            "receiveDocumentNumber": "<receive document number>",
            "eventDateTime": "<event date time>",
            "harvestDateStart": "<harvest date start>",
            "harvestDateEnd": "<harvest date end>",
            "harvestLocationId": "<harvest location id>",
            "receivedLocationId": "<received location id>",
            "foodsReceived": [
                {
                    "receivedDocumentLineNumber": "<receive document line number>",
                    "receivedProductId": "<receive product id>",
                    "vendorItemCode": "<vendor item code>",
                    "receivedLotNumber": "<received lot number>",
                    "receivedCaseGtin": "<received case gtin>",
                    "receivedQuantity": <received quanitity>,
                    "receivedQuantityUom": "<received quantity uom>",
                    "foodReceivedExpirationDate": "<food received expiration date>",
                    "foodReceivedProductionDate": "<food received production date>",
                    "foodReceivedPackagingDate": "<food received packaging date>",
                    "foodReceivedBestBeforeDate": "<food received best before date>",
                    "foodReceivedHarvestDate": "<food received harvest date>",
                }
            ]
        }
    ]
}

Data Constraints​

Please note the following data constraints:

  • strings allow a maximum of 100 characters
  • dates must use the format: yyyy-MM-dd
  • datetimes must use the format: yyyy-MM-ddTHH:mm:ssZ (UTC) or yyyy-MM-ddTHH:mm:ss-hh:00 (UTC minus) or yyyy-MM-ddTHH:mm:ss+hh:00 (UTC plus)

Product Data​

Required​

  • itemCode (string): The vendor or purchaser item code that will be referenced in the event
  • itemDescription (string): Product Description from the product owner or original purchase order

Additional information will be required in the eventList section.

Optional​

  • alternateItemCode (string): This field provides sender and shipper to use and alternate identifier for products. This could be a URL, a UUID, or other globally unique identification scheme. The important thing is that it is unique per product and shared between shipper and receiver. For example, this could be a GS1 Digital Link URL for the product
  • gtin (string): Case-level Global Trade Identification Number (GTIN-14). GS1 GTIN Executive Summary
  • itemUpc (string): Item-level Universal Product Code, may be GTIN-8, GTIN-12, or GTIN-13. GS1 GTIN Executive Summary
  • innerPackUpc (string): Point of sale barcode, may be GTIN-8, GTIN-12, GTIN-13, or GTIN-14. GS1 GTIN Executive Summary
  • plu (string): Item-level Price Look-up Code. PLU Codes Search — IFPS
  • isFtlItem (boolean): Indicates whether product is on the Food Traceability List (FTL)
  • ftlCategory (string)*: Indicates the product's FTL category, i.e. “soft cheese”, “shell eggs”, “nut butter”, “cucumbers”, “herbs”, “leafy greens”, “melons”, “peppers”, “sprouts”, “tomatoes”, “tropical tree fruits”, “fresh-cut fruits”, “fresh-cut vegetables”, “finfish”, “smoked finfish”, “crustaceans”, “molluscan shellfish”, “ready-to-eat deli salads”, or “multiple-ftl-ingredients” *Required if on the FTL 
  • brandName (string): The brand of the product that appears on the consumer package
  • packStyle (string): Product's pack style, e.g. "Case", "Carton", "Tray", "Clamshell", etc.
  • packSize (string): Product's pack size as Packaging Configuration OR Count OR Weight + Unit of Measure, e.g. "20 x 12 oz bags"
  • productCommodity (string): For fresh produce, a description of the commodity, e.g. "Peppers"
  • productVariety (string): For fresh produce a description of the variety when applicable, e.g. "Jalapeno"
  • scientificName (string): For seafood the scientific name of the species, see: FDA Seafood List
  • acceptableSpeciesName (string): For seafood a description of the common species name, see: FDA Seafood List
  • isCoveredByGdst (boolean): Flag to indicate that product is part of GDST

Location Data​

Required​

  • locationName (string): Name of vendor's or purchaser's location referenced in the event
  • locationCode (string): Vendor's or purchaser's location code referenced in the event

If address and contact information is already set up in master data with locationCode, then the address information is not required. Otherwise, it is required. Provide at least one of the following:

  • gln (string): GS1 Global Location Number, a 13-digit string. GS1 GTIN Executive Summary
  • duns (string): Dun & Bradstreet Data Universal Numbering System number, a 9-digit string
  • address (object):
    • streetAddress1 (string): Physical street address line 1 information
    • streetAddress2 (string): Physical street address line 2 information, if applicable
    • city (string): City location
    • state (string): State or region location
    • postalCode (string): ZIP or postal code
    • country (string): Country location
    • geoLocation optional (object): Consisting of either...
      • gpsCoordinates as an array of strings representing the latitude followed by longitude expressed in degrees and minutes OR
      • geoFence as an array of string arrays representing the latitude followed by longitude expressed in degrees and minutes for each set of coordinates defining the geo fence

Optional​

  • businessUnit (string): Indicates the business unit associated with the location.
  • market (string): Indicates the market associated with the location.
  • region (string): Indicates the region assocaited with the location.
  • locationType (string): Indicates whether the location is "Internal", "Supplier", or "Customer"
  • glnAssignedBy (string): Indicates whether it was assigned by "GS1", "GLOBALGAP", "Internal", "Trading Partner", or "Other"
  • alternateLocationCode (string): This field provides sender and shipper to use and alternate identifier for connecting locations. This could be a URL, a UUID, or other globally unique identification scheme. The important thing is that it is unique per location and is shared between shipper and receiver. For example, this could be a GS1 Digital Link or Google Place ID
  • phoneNumber (string)*: Phone number including country code with format: +1.999.999.999 *This field is required if address is used to identify location
  • isPrimaryLocation (boolean): This indicates that the location is the primary headquarter location for the organization
  • isCoveredByGdst (boolean): Indicates that this location is covered by the Global Dialogue on Seafood Traceability requirements

Event Data​

warning

When sending an event payload, the payload must contain the complete set of records for the corresponding event date time. DO NOT send more than one payload with the same event date time.

Required​

  • eventDateTime (datetime): Date and time when seafood was received or landed.
  • receivedProductId (string): This Product ID should be stored in your master data. If the cases you produce in initial packing are labeled with case GTIN-14s, the GTIN should be stored in the product master data record for the Product ID referenced.
  • receivedLotNumber (string): This is the Lot Number for the foods received.
  • receivedQuantity (string): The number of units of this TLC received.

One of the following is required, the others are Optional​

  • foodReceivedExpirationDate (date): Food Received expiration Date
  • foodReceivedProductionDate (date): Food Received Production Date
  • foodReceivedPackagingDate (date): Food Received Packaging Date
  • foodReceivedBestBeforeDate (date): Food Received Best Before Date
  • foodReceivedHarvestDate (date): Food Received Harvest Date

Optional​

  • harvestDateStart (string): Date when harvesting of seafood began.
  • harvestDateEnd (string): Date when harvesting of seafood was completed.
  • harvestLocationId (string): Location of harvesting of seafood.
  • receivedLocationId (string): References a location set up in master data. This is also known as the TLC Source.
  • receivedDocumentLineNumber (string): This links the TLC to the line item on the work order.
  • vendorItemCode (string): This is the item code / product id provided by the supplier. This should be stored in your master data.
  • receivedCaseGtin (string): This is the GTIN-14 of cases of food received
  • receivedQuantityUom (string): Unit of measure (e.g., Case) for TLC received.

Sample Payload​

{
    "productMasterDataList": [
        {
            "itemCode": "54167",
            "itemDescription": "Fresh Oysters",
            "isFtlItem": true,
            "ftlCategory": "seafood",
            "brandName": "Sea Fresh",
            "packStyle": "",
            "packSize": "",
            "productCommodity": "",
            "productVariety": "",
            "scientificName": "",
            "acceptableSpeciesName": "",
            "gtin": "",
            "innerPackUpc": "",
            "itemUpc": "",
            "plu": "",
            "alternateItemCode": "",
            "isCoveredByGdst": true
        },
        {
            "itemCode": "21434",
            "itemDescription": "Fresh Sallops",
            "isFtlItem": true,
            "ftlCategory": "seafood",
            "brandName": "Sea Fresh",
            "packStyle": "",
            "packSize": "",
            "productCommodity": "",
            "productVariety": "",
            "scientificName": "",
            "acceptableSpeciesName": "",
            "gtin": "",
            "innerPackUpc": "",
            "itemUpc": "",
            "plu": "",
            "alternateItemCode": "",
            "isCoveredByGdst": true
        }
    ],
    "locationMasterList": [
        {
            "locationCode": "2480",
            "locationType": "Internal",
            "locationName": "Fishing",
            "gln": "",
            "glnAssignedBy": "",
            "duns": "",
            "alternateLocationCode": "",
            "phoneNumber": "+15555555555",
            "isPrimaryLocation": true,
            "isCoveredByGdst": true,
            "geoLocation": {
                "gpsCoordinates": [
                    "36.271142",
                    "-78.593557"
                ],
                "geoFence": [
                    ["50.942499","6.898247"], 
                    ["50.942275","6.898292"], 
                    ["50.942263","6.898094"], 
                    ["50.942106","6.898126"], 
                    ["50.942130","6.898526"], 
                    ["50.942512","6.898451"], 
                    ["50.942499","6.898247"]
                ]
            }
        },
     {
            "locationCode": "191446525",
            "locationType": "Internal",
            "locationName": "Sea Farms R1",
            "gln": "",
            "glnAssignedBy": "",
            "duns": "",
            "alternateLocationCode": "",
            "phoneNumber": "+15555555555",
            "isPrimaryLocation": true,
            "isCoveredByGdst": true,
            "address": {
                
                "streetAddress1": "1 Seaway",
                "streetAddress2": "Dock 11",
                "city": "Seaside",
                "state": "WA",
                "postalCode": "99999",
                "country": "USA"
            }}
    ],
    "eventList": [
        {
            "eventDateTime": "2024-10-10T00:12:34Z",
            "receiveDocumentNumber": "123-27",
            "harvestLocationCode": "2480",
            "receivedLocationCode": "191446525",
            "harvestDateStart": "2025-01-22",
            "harvestDateEnd": "2025-01-26",
            "foodsReceived": [
                {
                    "receivedDocumentLineNumber": "01",
                    "receivedProductCode": "541677777888",
                    "receivedLotNumber": "64632",
                    "receivedCaseGtin": "",
                    "receivedQuantity": 9986,
                    "receivedQuantityUom": "LBS",
                    "foodReceivedExpirationDate": "2025-03-30",
                    "foodReceivedProductionDate": "2025-03-30",
                    "foodReceivedPackagingDate": "2025-03-30",
                    "foodReceivedBestBeforeDate": "2025-03-30",
                    "foodReceivedHarvestDate": "2025-03-30"
                }
            ]
        },
        {
            "eventDateTime": "2024-10-10T00:13:34Z",
            "receiveDocumentNumber": "123-28",
            "harvestLocationCode": "2480",
            "receivedLocationCode": "191446525",
            "harvestDateStart": "2025-01-22",
            "harvestDateEnd": "2025-01-26",
            "foodsReceived": [
                {
                    "receivedDocumentLineNumber": "02",
                    "receivedProductCode": "21434",
                    "receivedLotNumber": "646",
                    "receivedCaseGtin": "",
                    "receivedQuantity": 10502,
                    "receivedQuantityUom": "LBS",
                    "foodReceivedExpirationDate": "2025-03-30",
                    "foodReceivedProductionDate": "2025-03-30",
                    "foodReceivedPackagingDate": "2025-03-30",
                    "foodReceivedBestBeforeDate": "2025-03-30",
                    "foodReceivedHarvestDate": "2025-03-30"
                }
            ]
        }
    ]
}

Response​

First Land-Based Receiving data ingested successfully

{
    "request_ids": ["e8107014-7b89-48b7-83bd-aaa4fb21ece0"]
}